Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add AMM support #344

Merged
merged 74 commits into from
Sep 20, 2023
Merged

Add AMM support #344

merged 74 commits into from
Sep 20, 2023

Conversation

nkramer44
Copy link
Collaborator

@nkramer44 nkramer44 commented Jan 19, 2023 •
edited
Loading

Do not merge this until the AMM amendment is endorsed on XRPL Mainnet

This PR adds support for XLS-30 AMMs.

New Transaction Types

  • AmmCreate
  • AmmDeposit
  • AmmBid
  • AmmVote
  • AmmWithdraw
  • AmmDelete

New Client Methods

  • XrplClient.ammInfo calls amm_info, taking AmmInfoRequestParams as a parameter and returning an AmmInfoResult

Other Changes

  • XLS-30 introduces a new serializable type called Issue (used to specify Asset and Asset2 in an AMM). This PR adds an Issue type (called IssueType) to the binary codec module to encode/decode these values.
  • This PR includes both objects for the AMM ledger entry as well as the amm_info result object. While AmmInfoResult.amm() is very similar to the AMM ledger entry, the rippled API formats the AMM object differently in responses to amm_info. The AmmObject in this PR is basically inaccessible because XrplClient doesn't support the ledger_entry RPC, but it will be good to have in the codebase once we add that method

@nkramer44
add lsfAMM to AccountRoot
3c5eca7
@nkramer44
add AMM object mapping
1960147
@nkramer44
add AmmBid transaction type
c3cca21
@nkramer44
update definitions.json
53df22a
@nkramer44
add AmmCreate transaction
b078439
@nkramer44
add AmmDeposit transaction
c4bed00
@nkramer44
add AmmVote transaction
c06c248
@nkramer44
add AmmWithdraw transaction
4538d44
@nkramer44
add amm_info request response objects and XrplClient method.
adca5a3
@nkramer44
add new transactions to SignatureUtils
6d835a8
@nkramer44
checkpoint
812f8f6
@nkramer44
fix bug in IssueType that prevented decode
7b6aaff
@nkramer44
split out AmmInfoResult amm object
ab9a263
@nkramer44
write ITs and add different objects for AuctionSlots and AuthAccounts…
495ca80 
… in amm_info responses
@nkramer44
Merge branch 'main' into nk/amm-support
f93e84e
@nkramer44
fix tests
bdd78e1
@nkramer44
fix checkstyle
6d01ba9
@nkramer44
Merge branch 'nk/amm-support' of https://github.com/XRPLF/xrpl4j into…
71d687e 
… nk/amm-support
@nkramer44
update data-driven-tests to current set from xrpl.js
68128b4
@nkramer44
disable AmmITs
b1225af
@codecov
Copy link

codecov bot commented Jan 19, 2023 •
edited
Loading

Codecov Report

Patch coverage: 98.60% and project coverage change: +0.38% 🎉

Comparison is base (dae2fd6) 90.50% compared to head (804fa58) 90.88%.

Additional details and impacted files 
@@             Coverage Diff              @@
##               main     #344      +/-   ##
============================================
+ Coverage     90.50%   90.88%   +0.38%     
- Complexity     1504     1596      +92     
============================================
  Files           290      318      +28     
  Lines          4275     4489     +214     
  Branches        353      369      +16     
============================================
+ Hits           3869     4080     +211     
- Misses          281      282       +1     
- Partials        125      127       +2
Files Changed Coverage Δ
...java/org/xrpl/xrpl4j/model/client/XrplMethods.java 0.00% <ø> (ø)
...rg/xrpl/xrpl4j/model/ledger/AccountRootObject.java 100.00% <ø> (ø)
.../main/java/org/xrpl/xrpl4j/model/ledger/Issue.java 100.00% <ø> (ø)
...java/org/xrpl/xrpl4j/codec/binary/types/Issue.java 75.00% <75.00%> (ø)
.../org/xrpl/xrpl4j/codec/binary/types/IssueType.java 92.00% <92.00%> (ø)
...c/main/java/org/xrpl/xrpl4j/client/XrplClient.java 98.55% <100.00%> (+0.03%) ⬆️
...xrpl/xrpl4j/codec/binary/types/SerializedType.java 97.91% <100.00%> (+0.04%) ⬆️
...org/xrpl/xrpl4j/crypto/signing/SignatureUtils.java 99.65% <100.00%> (+0.06%) ⬆️
...java/org/xrpl/xrpl4j/model/client/amm/AmmInfo.java 100.00% <100.00%> (ø)
...pl/xrpl4j/model/client/amm/AmmInfoAuctionSlot.java 100.00% <100.00%> (ø)
... and 30 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

nkramer44 added 21 commits July 18, 2023 14:26
@nkramer44
add AMM related transaction metadata mappings and fixtures.
50f1e4c
@nkramer44
fix AmmIT
2b9d113
@nkramer44
fix checkstyle and update codec fixtures
2e2aa6c
@nkramer44
Merge branch 'main' into nk/amm-support
41832b7
@nkramer44
add javadoc to AmmDepositFlags and AmmWithdrawFlags explaining why th…
0c90c86 
…ere is no empty or unset option
@nkramer44
Merge branch 'nk/amm-support' of https://github.com/XRPLF/xrpl4j into…
9e3c562 
… nk/amm-support
@nkramer44
Merge branch 'main' into nk/amm-support
aa73d3d
@nkramer44
Merge branch 'main' of https://github.com/XRPLF/xrpl4j into nk/amm-su…
efb7638 
…pport
@nkramer44
fix checkstyle
9ddbbdf
@nkramer44
Merge branch 'main' into nk/amm-support
a449df5
@nkramer44
Merge branch 'main' of https://github.com/XRPLF/xrpl4j into nk/amm-su…
a4c7256 
…pport
@nkramer44
Enable AMM amendment in local rippled node and reenable AmmIT.
6e88d6f 
Update existing AMM transactions with the latest formats.
Remove any inference of flags based on fields because we're likely to get it wrong.
Update AMM transaction flags with new values.
Remove lsfAMM from AccountRootFlags and add AMMID to AccountRootObject.
@nkramer44
fix test
c5586af
@nkramer44
rename AmmInfo.account json property to amm_account
9202aab
@nkramer44
revert rename
bac0d62
@nkramer44
add amm_account option to AmmInfoRequestPArams
62c66eb
@nkramer44
add AmmDelete transaction
df34891
@nkramer44
checkstyle
c1de7aa
@nkramer44
add more coverage
c9d15be
@nkramer44
make all AMM code @beta
97aa77d
@nkramer44
fix javadoc errors
9a120f8
@nkramer44 nkramer44 changed the title [DO NOT MERGE] Add AMM support Add AMM support Sep 19, 2023
@nkramer44 nkramer44 marked this pull request as ready for review September 19, 2023 18:18
sappenin
sappenin approved these changes Sep 20, 2023
View reviewed changes
Copy link
Collaborator

@sappenin sappenin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nkramer44 nkramer44 merged commit 530e969 into main Sep 20, 2023
17 of 19 checks passed
@nkramer44 nkramer44 deleted the nk/amm-support branch September 20, 2023 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sappenin sappenin sappenin approved these changes

@nhartner nhartner Awaiting requested review from nhartner nhartner is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nkramer44 @sappenin